/*
This software is distributed under the Simplified BSD License:

Copyright (c) 2008, Chris Venter <chris.venter@gmail.com>
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, 
are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice, 
    	this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice, 
    	this list of conditions and the following disclaimer in the documentation 
    	and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 
DAMAGE.
*/
#ifndef GENERIK_H
#define GENERIK_H

/*
This file is a place holder for Doxygen documentation which does not properly fit
in the source code itself.
*/

/**
\file generik.h

\page generik_page The %generik library
From the README file:
\include generik/README

Most of the functionality of the %generik library can be directly accessed by browsing the
namespace: generik

*/
/*
For a more introductory overview of the main parts, see the following list:
<ul>
	<li>\ref generik_tracing_page</li>
	<li>\ref generik_gtk_page<ul>
		<li>\ref generik_gtk_macros_page</li>
		<li>\ref generik_gtk_init_page</li>
		<li>\ref generik_gtk_widget_page</li>
		<li>\ref generik_gtk_treeview_page</li>
	</ul></li>
	<li>\ref generik_glade_page</li>
	<li>\ref generik_media_page<ul>
		<li>\ref generik_media_gstreamer_page</li>
	</ul></li>
</ul>
*/

/**
\namespace generik
The %generik namespace wraps all the code in the %generik library.
It contains a couple of sub-namespaces, particularly the gtk sub-namespace, which
(as the name suggests) wraps the gtk-specific code.

For the README file, please see \ref generik_page.
*/

/*
\page generik_tracing_page %generik Tracing
\page generik_gtk_page %generik GTK
\page generik_gtk_init_page %generik GTK Initialisation
\page generik_gtk_macros_page %generik GTK Macros
\page generik_gtk_widget_page %generik GTK Widget
\page generik_gtk_treeview_page %generik GTK Treeview
\page generik_glade_page %generik Glade
\page generik_media_page %generik Media
\page generik_media_gstreamer_page %generik GStreamer
*/

#endif










